Shipments
The Shipments section, within the Operations module, lets you manage the document types used for shipments.
You can view, create, edit, and delete document types, and define when each type is available.
In this guide
- View the Documents list
- Create a Document Type
- Complete its general information
- Configure its behavior
- Complete the configuration
General workflow
- View or search shipment document types from the main list.
- Select Create Shipment Document Type.
- Enter a name and code, then define where the document type applies.
- Set whether it is required, visible in the Portal, and active.
- Select Create to save it.
Documents List
The list displays document types configured for shipments and their main information.
Figure 1. Shipment document types list
List Information
Indicates the order assigned to the document type.
Identifies the document type within the system.
Indicates the name assigned to the document type.
Indicates the transport modes in which the document type is available.
Indicates the trade directions for which the document type is available.
Indicates the shipment structures to which the document type applies.
Indicates whether the document type is configured as required.
Indicates whether the document type is generated by the system.
Indicates whether the document is visible in the Portal by default.
Indicates whether the document type is enabled for use.
List Actions
Finds document types in the list.
Starts the registration of a new shipment document type.
Modifies an existing document type's configuration.
Deletes a registered document type.
Create Document Type
The Create Shipment Document Type option opens a form for registering a document type and defining when it is available.
Figure 2. Shipment document type creation form
General Information
Enter a name to identify the document type.
Enter a code to identify the document type.
Define the transport modes in which the document is available.
Define the trade directions for which the document is available.
Define the shipment structures to which the document applies.
Define the document type's display order.
If Transport Modes is empty, the document applies to all transport modes.
If Applies To is empty, the document applies to all shipment structures.
Configuration
When enabled, the document is created automatically for each new shipment according to the configured transport mode and trade direction.
Indicates whether the document type is generated by the system.
Defines whether the document is visible in the Portal by default.
Defines whether the document type is enabled for use.
Document types generated by the system cannot be created or edited from this form.
Name and Code are required fields.
Actions
Saves the document type and completes its creation.
Saves the current document type and starts a new one.
Closes the form without creating the document type.
Complete the Configuration
Once created, the document type is available according to the conditions defined in its configuration.